﻿#region Copyright (c) 2003 - 2008, Andreas Mueller
/////////////////////////////////////////////////////////////////////////////////////////
// 
// Copyright (c) 2003 - 2008, Andreas Mueller.
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// Contributors:
//    Andreas Mueller - initial API and implementation
//
// 
// This software is derived from software bearing the following
// restrictions:
// 
// Copyright (c) 1994
// Hewlett-Packard Company
// 
// Permission to use, copy, modify, distribute and sell this software
// and its documentation for any purpose is hereby granted without fee,
// provided that the above copyright notice appear in all copies and
// that both that copyright notice and this permission notice appear
// in supporting documentation.  Hewlett-Packard Company makes no
// representations about the suitability of this software for any
// purpose.  It is provided "as is" without express or implied warranty.
// 
// 
// Copyright (c) 1996,1997
// Silicon Graphics Computer Systems, Inc.
// 
// Permission to use, copy, modify, distribute and sell this software
// and its documentation for any purpose is hereby granted without fee,
// provided that the above copyright notice appear in all copies and
// that both that copyright notice and this permission notice appear
// in supporting documentation.  Silicon Graphics makes no
// representations about the suitability of this software for any
// purpose.  It is provided "as is" without express or implied warranty.
// 
// 
// (C) Copyright Nicolai M. Josuttis 1999.
// Permission to copy, use, modify, sell and distribute this software
// is granted provided this copyright notice appears in all copies.
// This software is provided "as is" without express or implied
// warranty, and with no claim as to its suitability for any purpose.
// 
/////////////////////////////////////////////////////////////////////////////////////////
#endregion


using NStl.Iterators;

namespace NStl
{

    public static partial class Algorithm
    {
        /// <summary>
        /// <para>
        /// Applies the function object func to each element in the range [first, last); 
        /// func's return value, if any, is ignored. Applications are performed in forward order, 
        /// i.e. from first to last. ForEach returns the function object after it has been
        /// applied to each element.
        /// </para>
        /// <para>
        /// The complexity is linear. Exactly last - first applications of func.
        /// </para>
        /// </summary>
        /// <param name="first">
        /// An input iterator pointing to the first element of the range.</param>
        /// <param name="last">
        /// An input iterator pointing one past the final element of the range.
        /// </param>
        /// <param name="func">The functor that is applied to each element of the range.</param>
        /// <returns></returns>
        /// <remarks>
        /// This return value is sometimes useful, since a function object may have local state. 
        /// It might, for example, count the number of times that it is called, 
        /// or it might have a status flag to indicate whether or not a call succeeded.
        /// </remarks>
        public static IUnaryFunction<T, Result>
            ForEach<T, Result>(IInputIterator<T> first, IInputIterator<T> last, IUnaryFunction<T, Result> func)
        {
            first = (IInputIterator<T>)first.Clone();
            for (; !Equals(first, last); first.PreIncrement())
                func.Execute(first.Value);
            return func;
        }
    }
}
